Micron Document
πŸŽ–οΈGitΠ―Ρ€Π°πŸŽ–οΈ


Displaying Raw β€’ Download

feature/firmware/src/commonTest/kotlin/org/meshtastic/feature/firmware/IsValidFirmwareFileTest.kt 60b7908e1bfeb63eee3dcf6df655da4adb72e6c0 (60b7908e) Text, 4.45 KB

T8b949e/*
* Copyright (c) 2026 Meshtastic LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Tff7b72package T7ee787org.meshtastic.feature.firmware

Tff7b72import T7ee787kotlin.test.Test
Tff7b72import T7ee787kotlin.test.assertFalse
Tff7b72import T7ee787kotlin.test.assertTrue

T8b949e/**
* Tests for [isValidFirmwareFile] β€” the pure function that filters firmware binaries from other artifacts that share
* the same extension (e.g. `littlefs-*`, `bleota*`, `mt-*`, `*.factory.*`).
*/
Tff7b72class T56d364IsValidFirmwareFileTest Tb4b4b4{

T8b949e// ── Positive cases ──────────────────────────────────────────────────────

Tf0883e@Test
Tff7b72fun Td2a8ff`standard firmware bin matches`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`standard firmware uf2 matches`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-pico-2.5.0.uf2Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffpicoTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`target with underscore separator matches`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-rak4631_eink-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffrak4631_einkTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`filename starting with target-dash matches`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ffheltec-v3-firmware-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`filename starting with target-dot matches`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ffheltec-v3.firmware.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`ota zip matches for nrf target`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertTrueTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-rak4631-2.5.0-ota.zipTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffrak4631Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.zipTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

T8b949e// ── Exclusion patterns ──────────────────────────────────────────────────

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects littlefs prefix`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fflittlefs-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects bleota prefix`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ffbleota-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects bleota0 prefix`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ffbleota0-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects mt- prefix`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ffmt-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects factory binary`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-heltec-v3-2.7.17.factory.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

T8b949e// ── Wrong extension / target mismatch ───────────────────────────────────

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects wrong extension`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-heltec-v3-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects when target not present`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-tbeam-2.7.17.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`rejects target substring without boundary`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// "pico" appears in "pico2w" but "pico" should not match "pico2w" without a boundary char
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware-pico2w-2.7.17.uf2Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffpicoTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

T8b949e// ── Edge cases ──────────────────────────────────────────────────────────

Tf0883e@Test
Tff7b72fun Td2a8ff`empty filename returns false`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffheltec-v3Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.binTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`empty target returns false`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// Empty target makes the regex match anything, but contains("") is always true β€”
T8b949e// the function still requires the extension
Te6edf3assertFalseTb4b4b4(Te6edf3isValidFirmwareFileTb4b4b4(Ta5d6ff"Ta5d6fffirmware.binTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.uf2Ta5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

Served by rngit 1.5.0 - Generated in 0.05s